package com.sky.shortlink.admin.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.sky.shortlink.admin.dao.entity.UserDO;
import com.sky.shortlink.admin.dto.req.UserLoginReqDTO;
import com.sky.shortlink.admin.dto.req.UserRegisterReqDTO;
import com.sky.shortlink.admin.dto.req.UserUpdateReqDTO;
import com.sky.shortlink.admin.dto.resp.UserLoginRespDTO;
import com.sky.shortlink.admin.dto.resp.UserRespDTO;

/**
 * @author Blue sky
 * @Description 用户接口层
 * @create 2024-02-15 16:42
 */
public interface UserService extends IService<UserDO> {

    /**
     * 根据用户名返回用户信息
     *
     * @param username
     * @return 用户返回实体
     */
    UserRespDTO getUserByUsername(String username);

    /**
     * 查询用户名是否存在
     *
     * @param username
     * @return 存在返回true  反之false
     */
    Boolean hasUsername(String username);

    /**
     * 用户注册
     *
     * @param registerReqDTO 用户注册请求参数体
     */
    void register(UserRegisterReqDTO registerReqDTO);

    /**
     * 修改用户
     *
     * @param userUpdateReqDTO 用户修改请求参数体
     */
    void update(UserUpdateReqDTO userUpdateReqDTO);

    /**
     * 用户登录
     *
     * @param loginReqDTO 用户登录请求参数体
     * @return 返回 token
     */
    UserLoginRespDTO login(UserLoginReqDTO loginReqDTO);

    /**
     * 检查用户是否登录
     *
     * @param username
     * @param token
     * @return 已登录返回 TRUE,反之FALSE
     */
    Boolean check(String username, String token);

    /**
     * 用户退出登录
     *
     * @param username
     * @param token
     */
    void logout(String username, String token);
}
